Returns information about a specific organization network

Returns information about a specific organization network

Path Parameters

networkId string required

Unique identifier of the network

orgid string required

Unique identifier of the organization

Responses

• 200
• 401
• 429
• 500

---

Detailed information of the specified Network

application/json

Schema

Example (from schema)

Example

---

Schema

authorId string
description string
authTokens string[]
authorizationEndpoint string
capabilities string[]
clientId string
creationTime integer
dns object
domain string
servers string[]
enableBroadcast boolean
id string
ipAssignmentPools object[]
Array [
ipRangeStart string
ipRangeEnd string
]
mtu integer
multicastLimit integer
name string
nwid string
objtype string
private boolean
remoteTraceLevel integer
remoteTraceTarget string
revision integer
routes object[]
Array [
target string
via string nullable
]
rules object[]
Array [
not boolean
or boolean
type string
]
rulesSource string
ssoEnabled boolean
tags string[]
v4AssignMode object
zt boolean
v6AssignMode object
6plane boolean
rfc4193 boolean
zt boolean

{
  "authorId": "string",
  "description": "string",
  "authTokens": [
    "string"
  ],
  "authorizationEndpoint": "string",
  "capabilities": [
    "string"
  ],
  "clientId": "string",
  "creationTime": 0,
  "dns": {
    "domain": "string",
    "servers": [
      "string"
    ]
  },
  "enableBroadcast": true,
  "id": "string",
  "ipAssignmentPools": [
    {
      "ipRangeStart": "string",
      "ipRangeEnd": "string"
    }
  ],
  "mtu": 0,
  "multicastLimit": 0,
  "name": "string",
  "nwid": "string",
  "objtype": "string",
  "private": true,
  "remoteTraceLevel": 0,
  "remoteTraceTarget": "string",
  "revision": 0,
  "routes": [
    {
      "target": "string",
      "via": "string"
    }
  ],
  "rules": [
    {
      "not": true,
      "or": true,
      "type": "string"
    }
  ],
  "rulesSource": "string",
  "ssoEnabled": true,
  "tags": [
    "string"
  ],
  "v4AssignMode": {
    "zt": true
  },
  "v6AssignMode": {
    "6plane": true,
    "rfc4193": true,
    "zt": true
  }
}

{
  "authTokens": [
    null
  ],
  "authorizationEndpoint": "",
  "capabilities": [],
  "clientId": "",
  "creationTime": 1698676570111,
  "dns": [],
  "enableBroadcast": true,
  "id": "8056c2e21c000001",
  "ipAssignmentPools": [
    {
      "ipRangeEnd": "172.25.25.254",
      "ipRangeStart": "172.25.25.1"
    }
  ],
  "mtu": 2800,
  "multicastLimit": 32,
  "name": "slimy-earwig",
  "nwid": "8056c2e21c000001",
  "objtype": "network",
  "private": true,
  "remoteTraceLevel": 0,
  "remoteTraceTarget": null,
  "revision": 1,
  "routes": [
    {
      "target": "172.25.25.0/24",
      "via": null
    }
  ],
  "rules": [
    {
      "not": false,
      "or": false,
      "type": "ACTION_ACCEPT"
    }
  ],
  "rulesSource": "",
  "ssoEnabled": false,
  "tags": [],
  "v4AssignMode": {
    "zt": true
  },
  "v6AssignMode": {
    "6plane": false,
    "rfc4193": false,
    "zt": false
  }
}

Unauthorized access, indicating that the request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

Schema

Example (from schema)

missingApiKey

invalidApiKey

---

Schema

error string

A message detailing the reason for the unauthorized status.

{
  "error": "Unauthorized: API key is missing or invalid."
}

API key is missing

{
  "error": "Unauthorized: API key is missing."
}

API key is invalid

{
  "error": "Unauthorized: API key is invalid."
}

Rate limit exceeded, indicating that the request was not accepted because the application has exceeded the rate limit for the API.

application/json

Schema

Example (from schema)

rateLimitExceededExample

---

Schema

error string

A message detailing the reason for exceeding the rate limit.

{
  "error": "Rate limit exceeded. Try again in X minutes."
}

Example response for rate limit exceeded

{
  "error": "Rate limit exceeded. Try again in 1 minute."
}

Internal Server Error, indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Example (from schema)

internalServerErrorExample

---

Schema

error string

A message detailing the unexpected condition encountered by the server.

{
  "error": "Internal server error. Please try again later."
}

Example response for an internal server error

{
  "error": "Internal server error. Please try again later."
}

Loading...